<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ESP32VGA: VGASignalsGenerator.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">ESP32VGA
   </div>
   <div id="projectbrief">ESP32 VGA Controller and Graphics Library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">VGASignalsGenerator.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="_v_g_a_signals_generator_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="preprocessor">#ifndef _VGASIGNALGENERATOR_H_INCLUDED</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="preprocessor">#define _VGASIGNALGENERATOR_H_INCLUDED</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;</div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;</div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="preprocessor">#include &quot;Arduino.h&quot;</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;</div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="preprocessor">#include &lt;stdint.h&gt;</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="preprocessor">#include &lt;stddef.h&gt;</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;</div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="preprocessor">#include &quot;rom/lldesc.h&quot;</span></div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;</div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_v_g_a_conf_8h.html">VGAConf.h</a>&quot;</span></div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;</div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;</div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespace_e_s_p32_v_g_a.html">ESP32VGA</a> {</div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;</div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="preprocessor">#if VGACOLORS == 8</span></div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="preprocessor">#  define VGAREDBIT   0</span></div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="preprocessor">#  define VGAGREENBIT 1</span></div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="preprocessor">#  define VGABLUEBIT  2</span></div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="preprocessor">#  define VGAHSYNCBIT 3</span></div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="preprocessor">#  define VGAVSYNCBIT 4</span></div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="preprocessor">#elif VGACOLORS == 64</span></div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="preprocessor">#  define VGAREDBIT   0</span></div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="preprocessor">#  define VGAGREENBIT 2</span></div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="preprocessor">#  define VGABLUEBIT  4</span></div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;<span class="preprocessor">#  define VGAHSYNCBIT 6</span></div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="preprocessor">#  define VGAVSYNCBIT 7</span></div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="preprocessor">#else</span></div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<span class="preprocessor">#  error &quot;VGACOLORS must be 8 or 64!&quot;</span></div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;</div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;</div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<span class="keyword">enum</span> VGAFrequency {</div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;  F_10727680Hz,</div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;  F_12000000Hz,</div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;  F_12336000Hz,</div><div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;  F_12588000Hz,</div><div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;  F_12600000Hz,</div><div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;  F_12930000Hz,</div><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;  F_13500000Hz,</div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;  F_13846000Hz,</div><div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;  F_13875000Hz,</div><div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;  F_14750000Hz,</div><div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;  F_15750000Hz,</div><div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;  F_16257000Hz,</div><div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;  F_17750000Hz,</div><div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;  F_18000000Hz,</div><div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;  F_20000000Hz,</div><div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;  F_21210000Hz,</div><div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;  F_22450000Hz,</div><div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;  F_24750000Hz,</div><div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;  F_25000000Hz,</div><div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;  F_25175000Hz,</div><div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;  F_25180000Hz,</div><div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;  F_25200000Hz,</div><div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;  F_27000000Hz,</div><div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;  F_27027000Hz,</div><div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;  F_28150000Hz,</div><div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;  F_28322000Hz,</div><div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;  F_28640000Hz,</div><div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;  F_29500000Hz,</div><div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;  F_30240000Hz,</div><div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;  F_31050000Hz,</div><div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;  F_31150000Hz,</div><div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;  F_31220000Hz,</div><div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;  F_31500000Hz,</div><div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;  F_32500000Hz,</div><div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;  F_34960000Hz,</div><div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;  F_35500000Hz,</div><div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;  F_36000000Hz,</div><div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;  F_40000000Hz,</div><div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;};</div><div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;</div><div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;</div><div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;</div><div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;<span class="keyword">typedef</span> void (*VGAVSyncInterrupt_t)();</div><div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;</div><div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;</div><div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;<span class="keyword">class </span>VGASignalsGeneratorClass {</div><div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;</div><div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;<span class="preprocessor">  #if VGACOLORS == 8</span></div><div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;  <span class="keywordtype">void</span> begin(gpio_num_t redGPIO, gpio_num_t greenGPIO, gpio_num_t blueGPIO, gpio_num_t HSyncGPIO, gpio_num_t VSyncGPIO, VGAVSyncInterrupt_t VSyncInterruptCallBack);</div><div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;<span class="preprocessor">  #endif</span></div><div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;<span class="preprocessor">  #if VGACOLORS == 64</span></div><div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;  <span class="keywordtype">void</span> begin(gpio_num_t red1GPIO, gpio_num_t red0GPIO, gpio_num_t green1GPIO, gpio_num_t green0GPIO, gpio_num_t blue1GPIO, gpio_num_t blue0GPIO, gpio_num_t HSyncGPIO, gpio_num_t VSyncGPIO, VGAVSyncInterrupt_t VSyncInterruptCallBack);</div><div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;<span class="preprocessor">  #endif</span></div><div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;</div><div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;  <span class="comment">// VGASignalsGeneratorClass is not owner of actual buffers. Can be used to change buffers count, maintainig already set pointers.</span></div><div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;  <span class="keywordtype">bool</span> setBuffersCount(<span class="keywordtype">int</span> buffersCount);</div><div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;  <span class="keywordtype">int</span> getBuffersCount() { <span class="keywordflow">return</span> m_buffersCount; }</div><div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;</div><div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;  <span class="comment">// length is in bytes. Max 4092 bytes.</span></div><div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;  <span class="comment">// Returns allocated buffer</span></div><div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;  <span class="keywordtype">void</span> * allocateBuffer(<span class="keywordtype">size_t</span> length);</div><div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;</div><div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;  <span class="keywordtype">size_t</span> getFreeMemory();</div><div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;</div><div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;  <span class="comment">// free buffer allocated with allocateBuffer()</span></div><div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;  <span class="keywordtype">void</span> freeBuffer(<span class="keywordtype">void</span> * buffer);</div><div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;</div><div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;  <span class="comment">// address must be allocated with allocateBuffer or even an address of another already allocated buffer</span></div><div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;  <span class="keywordtype">void</span> setBuffer(<span class="keywordtype">int</span> index, <span class="keywordtype">void</span> <span class="keyword">volatile</span> * address, <span class="keywordtype">int</span> length);</div><div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;</div><div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;  <span class="keywordtype">void</span> <span class="keyword">volatile</span> * getBuffer(<span class="keywordtype">int</span> index, <span class="keywordtype">int</span> * length);</div><div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;</div><div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;  <span class="keywordtype">void</span> start(VGAFrequency freq);</div><div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;</div><div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;  <span class="keywordtype">void</span> stop();</div><div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;</div><div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;  <span class="comment">// can be nested</span></div><div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;  <span class="keywordtype">void</span> enableVSyncInterrupts();</div><div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;  <span class="keywordtype">void</span> disableVSyncInterrupts();</div><div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;</div><div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;</div><div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;  <span class="keywordtype">void</span> init(gpio_num_t VSyncGPIO, VGAVSyncInterrupt_t VSyncInterruptCallBack);</div><div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;  <span class="keywordtype">void</span> setupGPIO(gpio_num_t gpio, <span class="keywordtype">int</span> bit, gpio_mode_t mode);</div><div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;  <span class="keywordtype">void</span> setupClock(VGAFrequency freq);</div><div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;</div><div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;  lldesc_t <span class="keyword">volatile</span> * m_dmabuffers;</div><div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;  <span class="keywordtype">int</span>                 m_buffersCount;</div><div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;  gpio_num_t          m_VSyncGPIO;</div><div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;  VGAVSyncInterrupt_t m_VSyncInterruptCallback;</div><div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160;  <span class="keywordtype">int</span>                 m_VSyncInterruptDisabled; <span class="comment">// 0 = enabled, &gt;0 disabled</span></div><div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;  <span class="keywordtype">bool</span>                m_started;</div><div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;};</div><div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160;</div><div class="line"><a name="l00139"></a><span class="lineno">  139</span>&#160;</div><div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;} <span class="comment">// end of namespace</span></div><div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;</div><div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;</div><div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;<span class="keyword">extern</span> ESP32VGA::VGASignalsGeneratorClass VGASignalsGenerator;</div><div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;</div><div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;</div><div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="_v_g_a_conf_8h_html"><div class="ttname"><a href="_v_g_a_conf_8h.html">VGAConf.h</a></div><div class="ttdoc">This file contains ESP32VGA library configuration settings, like number of supported colors...</div></div>
<div class="ttc" id="namespace_e_s_p32_v_g_a_html"><div class="ttname"><a href="namespace_e_s_p32_v_g_a.html">ESP32VGA</a></div><div class="ttdef"><b>Definition:</b> VGACanvas.cpp:7</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
